<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>xilplmi: XilPlmi Client APIs</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="HTML_custom.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="xlogo_bg.png"/></td>
  <td style="padding-left: 0.5em;">
   <div id="projectname">xilplmi
   </div>
   <div id="projectbrief">Vitis Drivers API Documentation</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Overview</span></a></li>
      <li><a href="globals.html"><span>APIs</span></a></li>
      <li><a href="files.html"><span>File&#160;List</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;"
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('group__xilplmi__client__apis.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#define-members">Macros</a> &#124;
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">XilPlmi Client APIs</div>  </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:ga5af1f3c98663f54ed993cb81c545ae79"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xilplmi__client__apis.html#ga5af1f3c98663f54ed993cb81c545ae79">XPLMI_ADDR_HIGH_SHIFT</a>&#160;&#160;&#160;(32U)</td></tr>
<tr class="memdesc:ga5af1f3c98663f54ed993cb81c545ae79"><td class="mdescLeft">&#160;</td><td class="mdescRight">Shift value to get higher 32 bit address.  <a href="#ga5af1f3c98663f54ed993cb81c545ae79">More...</a><br/></td></tr>
<tr class="separator:ga5af1f3c98663f54ed993cb81c545ae79"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga7e8e7117a32a2207abc17436a82cde25"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xilplmi__client__apis.html#ga7e8e7117a32a2207abc17436a82cde25">XPlmi_GetDeviceID</a> (XPlmi_ClientInstance *InstancePtr, XLoader_DeviceIdCode *DeviceIdCode)</td></tr>
<tr class="memdesc:ga7e8e7117a32a2207abc17436a82cde25"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function sends IPI request to provides Get device id.  <a href="#ga7e8e7117a32a2207abc17436a82cde25">More...</a><br/></td></tr>
<tr class="separator:ga7e8e7117a32a2207abc17436a82cde25"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga87c129257a8fabebacb9f764a4be628d"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xilplmi__client__apis.html#ga87c129257a8fabebacb9f764a4be628d">XPlmi_GetBoard</a> (XPlmi_ClientInstance *InstancePtr, u64 Addr, u32 Size, u32 *ResponseLength)</td></tr>
<tr class="memdesc:ga87c129257a8fabebacb9f764a4be628d"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function sends IPI request to Get board.  <a href="#ga87c129257a8fabebacb9f764a4be628d">More...</a><br/></td></tr>
<tr class="separator:ga87c129257a8fabebacb9f764a4be628d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gae746051336f43281004be2537db2c3d8"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xilplmi__client__apis.html#gae746051336f43281004be2537db2c3d8">XPlmi_TamperTrigger</a> (XPlmi_ClientInstance *InstancePtr, u32 TamperResponse)</td></tr>
<tr class="memdesc:gae746051336f43281004be2537db2c3d8"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function sends IPI request to Tamper Trigger.  <a href="#gae746051336f43281004be2537db2c3d8">More...</a><br/></td></tr>
<tr class="separator:gae746051336f43281004be2537db2c3d8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga41f2113dce651f9b36a2abefa10be64c"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xilplmi__client__apis.html#ga41f2113dce651f9b36a2abefa10be64c">XPlmi_EventLogging</a> (XPlmi_ClientInstance *InstancePtr, u32 sub_cmd, u64 Addr, u32 Len)</td></tr>
<tr class="memdesc:ga41f2113dce651f9b36a2abefa10be64c"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function sends IPI request to Event Logging.  <a href="#ga41f2113dce651f9b36a2abefa10be64c">More...</a><br/></td></tr>
<tr class="separator:ga41f2113dce651f9b36a2abefa10be64c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga0055868baa98bae19b5d94d65b92189b"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xilplmi__client__apis.html#ga0055868baa98bae19b5d94d65b92189b">XPlmi_ConfigSecureComm</a> (XPlmi_ClientInstance *InstancePtr, XPlmi_SsitSecComm *SsitSecCommDataPtr)</td></tr>
<tr class="memdesc:ga0055868baa98bae19b5d94d65b92189b"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function sends IPI request to configure secure communication.  <a href="#ga0055868baa98bae19b5d94d65b92189b">More...</a><br/></td></tr>
<tr class="separator:ga0055868baa98bae19b5d94d65b92189b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaf2f52002fc35d8a8b40cb6dbc5bfc7a3"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xilplmi__client__apis.html#gaf2f52002fc35d8a8b40cb6dbc5bfc7a3">XPlmi_GetSecureCommStatus</a> (XPlmi_ClientInstance *InstancePtr, u32 SlrIndex, u32 *SecCommStatus)</td></tr>
<tr class="memdesc:gaf2f52002fc35d8a8b40cb6dbc5bfc7a3"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function sends IPI request to get secure communication status.  <a href="#gaf2f52002fc35d8a8b40cb6dbc5bfc7a3">More...</a><br/></td></tr>
<tr class="separator:gaf2f52002fc35d8a8b40cb6dbc5bfc7a3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga73244b8606628c8941215ea3b3e5cc84"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xilplmi__client__apis.html#ga73244b8606628c8941215ea3b3e5cc84">XPlmi_SetDDRMCMainRegSts</a> (XPlmi_ClientInstance *InstancePtr, u32 DDRMCNum, u32 RegSts)</td></tr>
<tr class="memdesc:ga73244b8606628c8941215ea3b3e5cc84"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function sends IPI request to set DDRMC main registers status command.  <a href="#ga73244b8606628c8941215ea3b3e5cc84">More...</a><br/></td></tr>
<tr class="separator:ga73244b8606628c8941215ea3b3e5cc84"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga9aa8c572abe57e4552a86bdf06e5c8e8"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xilplmi__client__apis.html#ga9aa8c572abe57e4552a86bdf06e5c8e8">XPlmi_InputSlrIndex</a> (XPlmi_ClientInstance *InstancePtr, u32 SlrIndex)</td></tr>
<tr class="memdesc:ga9aa8c572abe57e4552a86bdf06e5c8e8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Adds the SLR Index.  <a href="#ga9aa8c572abe57e4552a86bdf06e5c8e8">More...</a><br/></td></tr>
<tr class="separator:ga9aa8c572abe57e4552a86bdf06e5c8e8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga312e47feb0264d1df52b0505eef675eb"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xilplmi__client__apis.html#ga312e47feb0264d1df52b0505eef675eb">XPlmi_InPlacePlmUpdate_DDR</a> (XPlmi_ClientInstance *Ptr, const u32 Flag, u32 DDRAddr)</td></tr>
<tr class="memdesc:ga312e47feb0264d1df52b0505eef675eb"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function sends IPI request to In place plm update status.  <a href="#ga312e47feb0264d1df52b0505eef675eb">More...</a><br/></td></tr>
<tr class="separator:ga312e47feb0264d1df52b0505eef675eb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga5b26ec2d046651d51851eef8149c511d"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xilplmi__client__apis.html#ga5b26ec2d046651d51851eef8149c511d">XPlmi_InPlacePlmUpdate_ImageStore</a> (XPlmi_ClientInstance *Ptr, const u32 Flag, u32 PdiId)</td></tr>
<tr class="memdesc:ga5b26ec2d046651d51851eef8149c511d"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function sends IPI request to In place plm update status through Image store.  <a href="#ga5b26ec2d046651d51851eef8149c511d">More...</a><br/></td></tr>
<tr class="separator:ga5b26ec2d046651d51851eef8149c511d"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a class="anchor" id="ga5af1f3c98663f54ed993cb81c545ae79"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XPLMI_ADDR_HIGH_SHIFT&#160;&#160;&#160;(32U)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Shift value to get higher 32 bit address. </p>

<p>Referenced by <a class="el" href="group__xilplmi__client__apis.html#ga0055868baa98bae19b5d94d65b92189b">XPlmi_ConfigSecureComm()</a>, <a class="el" href="group__xilplmi__client__apis.html#ga41f2113dce651f9b36a2abefa10be64c">XPlmi_EventLogging()</a>, and <a class="el" href="group__xilplmi__client__apis.html#ga87c129257a8fabebacb9f764a4be628d">XPlmi_GetBoard()</a>.</p>

</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="ga0055868baa98bae19b5d94d65b92189b"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int XPlmi_ConfigSecureComm </td>
          <td>(</td>
          <td class="paramtype">XPlmi_ClientInstance *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">XPlmi_SsitSecComm *&#160;</td>
          <td class="paramname"><em>SsitSecCommDataPtr</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function sends IPI request to configure secure communication. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>Pointer to the client instance </td></tr>
    <tr><td class="paramname">SsitSecCommDataPtr</td><td>Pointer to structure which contains SLR index, IV1, IV2 and key</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>XST_SUCCESS on success.</li>
<li>XST_FAILURE on failure. </li>
</ul>
</dd></dl>
<ul>
<li>Performs input parameters validation. Return error code if input parameters are invalid</li>
<li>Send an IPI request to the PLM by using the XPlmi_SsitCfgSecComm CDO command Wait for IPI response from PLM with a timeout.</li>
<li>If the timeout exceeds then error is returned otherwise it returns the status of the IPI response.</li>
</ul>

<p>References <a class="el" href="group__xilplmi__client__apis.html#ga5af1f3c98663f54ed993cb81c545ae79">XPLMI_ADDR_HIGH_SHIFT</a>, <a class="el" href="xplmi__defs_8h.html#ac95cc36b490cf20f84746f656e3a7d83">XPLMI_CONFIG_SECCOMM_CMD_ID</a>, <a class="el" href="xplmi__defs_8h.html#a5cdce3a896940495898454b13f2176c1">XPLMI_HEADER_LEN_3</a>, and <a class="el" href="group__xilplmi__mailbox__apis.html#ga1cd29e5865f729668d2048de195cf33f">XPlmi_ProcessMailbox()</a>.</p>

</div>
</div>
<a class="anchor" id="ga41f2113dce651f9b36a2abefa10be64c"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int XPlmi_EventLogging </td>
          <td>(</td>
          <td class="paramtype">XPlmi_ClientInstance *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u32&#160;</td>
          <td class="paramname"><em>sub_cmd</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u64&#160;</td>
          <td class="paramname"><em>Addr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u32&#160;</td>
          <td class="paramname"><em>Len</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function sends IPI request to Event Logging. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>Pointer to the client instance </td></tr>
    <tr><td class="paramname">sub_cmd</td><td>To configure the debug information </td></tr>
    <tr><td class="paramname">Addr</td><td>Address where the event has to happen </td></tr>
    <tr><td class="paramname">Len</td><td>Length of the buffer</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>XST_SUCCESS on success.</li>
<li>XST_FAILURE on failure. </li>
</ul>
</dd></dl>
<ul>
<li>Performs input parameters validation. Return error code if input parameters are invalid</li>
<li>Send an IPI request to the PLM by using the XPlmi_EventLogging CDO command Wait for IPI response from PLM with a timeout.</li>
<li>If the timeout exceeds then error is returned otherwise it returns the status of the IPI response.</li>
</ul>

<p>References <a class="el" href="group__xilplmi__client__apis.html#ga5af1f3c98663f54ed993cb81c545ae79">XPLMI_ADDR_HIGH_SHIFT</a>, <a class="el" href="xplmi__defs_8h.html#ae448e478d11a32abe990938860aa3be6">XPLMI_EVENT_LOGGING_CMD_ID</a>, <a class="el" href="xplmi__defs_8h.html#a390a530c727590c215c32297099e991d">XPLMI_HEADER_LEN_4</a>, <a class="el" href="group__xilplmi__mailbox__apis.html#ga1cd29e5865f729668d2048de195cf33f">XPlmi_ProcessMailbox()</a>, and <a class="el" href="xplmi__client_8h.html#ab1f20993bdf14a739d6c75cc390d9c92">XPLMI_SLR_INDEX_SHIFT</a>.</p>

</div>
</div>
<a class="anchor" id="ga87c129257a8fabebacb9f764a4be628d"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int XPlmi_GetBoard </td>
          <td>(</td>
          <td class="paramtype">XPlmi_ClientInstance *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u64&#160;</td>
          <td class="paramname"><em>Addr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u32&#160;</td>
          <td class="paramname"><em>Size</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u32 *&#160;</td>
          <td class="paramname"><em>ResponseLength</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function sends IPI request to Get board. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>Pointer to the client instance </td></tr>
    <tr><td class="paramname">Addr</td><td>Address where PLM has to copy the board details </td></tr>
    <tr><td class="paramname">Size</td><td>Max size available at destination for PLM to copy in words </td></tr>
    <tr><td class="paramname">ResponseLength</td><td>Length of board data that PLM copied</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>XST_SUCCESS on success.</li>
<li>XST_FAILURE on failure. </li>
</ul>
</dd></dl>
<ul>
<li>Performs input parameters validation. Return error code if input parameters are invalid</li>
<li>Send an IPI request to the PLM by using the XPlmi_GetBoard CDO command Wait for IPI response from PLM with a timeout.</li>
<li>If the timeout exceeds then error is returned otherwise it returns the status of the IPI response.</li>
</ul>

<p>References <a class="el" href="group__xilplmi__client__apis.html#ga5af1f3c98663f54ed993cb81c545ae79">XPLMI_ADDR_HIGH_SHIFT</a>, <a class="el" href="xplmi__defs_8h.html#aac351fba6246ff9f83fbf368f345e202">XPLMI_GET_BOARD_CMD_ID</a>, <a class="el" href="xplmi__defs_8h.html#a5cdce3a896940495898454b13f2176c1">XPLMI_HEADER_LEN_3</a>, and <a class="el" href="group__xilplmi__mailbox__apis.html#ga1cd29e5865f729668d2048de195cf33f">XPlmi_ProcessMailbox()</a>.</p>

</div>
</div>
<a class="anchor" id="ga7e8e7117a32a2207abc17436a82cde25"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int XPlmi_GetDeviceID </td>
          <td>(</td>
          <td class="paramtype">XPlmi_ClientInstance *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">XLoader_DeviceIdCode *&#160;</td>
          <td class="paramname"><em>DeviceIdCode</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function sends IPI request to provides Get device id. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>Pointer to the client instance </td></tr>
    <tr><td class="paramname">DeviceIdCode</td><td>used to store the Id code register values.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>XST_SUCCESS on success.</li>
<li>XST_FAILURE on failure. </li>
</ul>
</dd></dl>
<ul>
<li>Performs input parameters validation. Return error code if input parameters are invalid</li>
<li>Send an IPI request to the PLM by using the XPlmi_GetDeviceID CDO command Wait for IPI response from PLM with a timeout.</li>
<li>If the timeout exceeds then error is returned otherwise it returns the status of the IPI response.</li>
</ul>

<p>References <a class="el" href="xplmi__defs_8h.html#a651b24db1c69490f069924b96d005c94">XPLMI_GET_DEVICE_CMD_ID</a>, <a class="el" href="xplmi__defs_8h.html#a46424716b1566f702669fbb35ae2c9e7">XPLMI_HEADER_LEN_0</a>, and <a class="el" href="group__xilplmi__mailbox__apis.html#ga1cd29e5865f729668d2048de195cf33f">XPlmi_ProcessMailbox()</a>.</p>

</div>
</div>
<a class="anchor" id="gaf2f52002fc35d8a8b40cb6dbc5bfc7a3"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int XPlmi_GetSecureCommStatus </td>
          <td>(</td>
          <td class="paramtype">XPlmi_ClientInstance *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u32&#160;</td>
          <td class="paramname"><em>SlrIndex</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u32 *&#160;</td>
          <td class="paramname"><em>SecCommStatus</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function sends IPI request to get secure communication status. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>Pointer to the client instance </td></tr>
    <tr><td class="paramname">SlrIndex</td><td>SLR number for which secure communication establishment status is needed </td></tr>
    <tr><td class="paramname">SecCommStatus</td><td>Pointer to variable to which secure communication status is to be written</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>XST_SUCCESS on success.</li>
<li>XST_FAILURE on failure. </li>
</ul>
</dd></dl>
<ul>
<li>Performs input parameters validation. Return error code if input parameters are invalid</li>
<li>Send an IPI request to the PLM by using the XPlmi_GetSecureCommStatus CDO command Wait for IPI response from PLM with a timeout.</li>
<li>If the timeout exceeds then error is returned otherwise it returns the status of the IPI response.</li>
</ul>

<p>References <a class="el" href="xplmi__defs_8h.html#aac083acfe6fc852913aab86fb2ae5fcc">XPLMI_GETSECCOMM_STATUS_CMD_ID</a>, <a class="el" href="xplmi__defs_8h.html#a933c7ef25b0a10e53adef63013284acc">XPLMI_HEADER_LEN_1</a>, and <a class="el" href="group__xilplmi__mailbox__apis.html#ga1cd29e5865f729668d2048de195cf33f">XPlmi_ProcessMailbox()</a>.</p>

</div>
</div>
<a class="anchor" id="ga312e47feb0264d1df52b0505eef675eb"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int XPlmi_InPlacePlmUpdate_DDR </td>
          <td>(</td>
          <td class="paramtype">XPlmi_ClientInstance *&#160;</td>
          <td class="paramname"><em>Ptr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const u32&#160;</td>
          <td class="paramname"><em>Flag</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u32&#160;</td>
          <td class="paramname"><em>DDRAddr</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function sends IPI request to In place plm update status. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">Ptr</td><td>Pointer to XPlmi_ClientInstance </td></tr>
    <tr><td class="paramname">Flag</td><td>To enable / disable jtag </td></tr>
    <tr><td class="paramname">DDRAddr</td><td>Address of DDR</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>XST_SUCCESS on success.</li>
<li>XST_FAILURE on failure. </li>
</ul>
</dd></dl>

<p>References <a class="el" href="group__xilplmi__server__apis.html#ga8ddc1de78adaa52322685bd933f588e7">XPlmi_InPlacePlmUpdate()</a>.</p>

</div>
</div>
<a class="anchor" id="ga5b26ec2d046651d51851eef8149c511d"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int XPlmi_InPlacePlmUpdate_ImageStore </td>
          <td>(</td>
          <td class="paramtype">XPlmi_ClientInstance *&#160;</td>
          <td class="paramname"><em>Ptr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const u32&#160;</td>
          <td class="paramname"><em>Flag</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u32&#160;</td>
          <td class="paramname"><em>PdiId</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function sends IPI request to In place plm update status through Image store. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">Ptr</td><td>Pointer to XPlmi_ClientInstance </td></tr>
    <tr><td class="paramname">Flag</td><td>To enable / disable jtag </td></tr>
    <tr><td class="paramname">PdiId</td><td>Image store pdi id</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>XST_SUCCESS on success.</li>
<li>XST_FAILURE on failure. </li>
</ul>
</dd></dl>

<p>References <a class="el" href="group__xilplmi__server__apis.html#ga8ddc1de78adaa52322685bd933f588e7">XPlmi_InPlacePlmUpdate()</a>.</p>

</div>
</div>
<a class="anchor" id="ga9aa8c572abe57e4552a86bdf06e5c8e8"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int XPlmi_InputSlrIndex </td>
          <td>(</td>
          <td class="paramtype">XPlmi_ClientInstance *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u32&#160;</td>
          <td class="paramname"><em>SlrIndex</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Adds the SLR Index. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to instance XPlmi_ClientInstance </td></tr>
    <tr><td class="paramname">SlrIndex</td><td>- SLR index number</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>- XST_SUCCESS - On valid input SlrIndex.<ul>
<li>XST_FAILURE - On non valid input SlrIndex </li>
</ul>
</dd></dl>

<p>References <a class="el" href="xplmi__client_8h.html#ae1d85fe274333fdd2cfe49fab897df2d">XPLMI_SLR_INDEX_3</a>.</p>

</div>
</div>
<a class="anchor" id="ga73244b8606628c8941215ea3b3e5cc84"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int XPlmi_SetDDRMCMainRegSts </td>
          <td>(</td>
          <td class="paramtype">XPlmi_ClientInstance *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u32&#160;</td>
          <td class="paramname"><em>DDRMCNum</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u32&#160;</td>
          <td class="paramname"><em>RegSts</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function sends IPI request to set DDRMC main registers status command. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>Pointer to the client instance </td></tr>
    <tr><td class="paramname">DDRMCNum</td><td>DDRMC number </td></tr>
    <tr><td class="paramname">RegSts</td><td>To be set status</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>XST_SUCCESS on success.</li>
<li>XST_FAILURE on failure. </li>
</ul>
</dd></dl>
<ul>
<li>Performs input parameters validation. Return error code if input parameters are invalid</li>
<li>Send an IPI request to the PLM by using the XPlmi_SetDDRMCMainRegSts CDO command Wait for IPI response from PLM with a timeout.</li>
<li>If the timeout exceeds then error is returned otherwise it returns the status of the IPI response.</li>
</ul>

<p>References <a class="el" href="xplmi__defs_8h.html#a4dd9e69cf7522e4aa5b1a56726ec5481">XPLMI_DDRMC_MAINREG_STS_SET_CMD_ID</a>, <a class="el" href="xplmi__defs_8h.html#acc2ec018c08bc542927da5d538b8de3a">XPLMI_HEADER_LEN_2</a>, and <a class="el" href="group__xilplmi__mailbox__apis.html#ga1cd29e5865f729668d2048de195cf33f">XPlmi_ProcessMailbox()</a>.</p>

</div>
</div>
<a class="anchor" id="gae746051336f43281004be2537db2c3d8"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int XPlmi_TamperTrigger </td>
          <td>(</td>
          <td class="paramtype">XPlmi_ClientInstance *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u32&#160;</td>
          <td class="paramname"><em>TamperResponse</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function sends IPI request to Tamper Trigger. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>Pointer to the client instance </td></tr>
    <tr><td class="paramname">TamperResponse</td><td>To select the valid tamper response</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>Handoff to the Rom on success.</li>
<li>XST_FAILURE on failure. </li>
</ul>
</dd></dl>
<ul>
<li>Performs input parameters validation. Return error code if input parameters are invalid</li>
<li>Send an IPI request to the PLM by using the XPlmi_TamperTrigger CDO command Wait for IPI response from PLM with a timeout.</li>
<li>If the timeout exceeds then error is returned otherwise it returns the status of the IPI response.</li>
</ul>

<p>References <a class="el" href="xplmi__defs_8h.html#a933c7ef25b0a10e53adef63013284acc">XPLMI_HEADER_LEN_1</a>, <a class="el" href="group__xilplmi__mailbox__apis.html#ga1cd29e5865f729668d2048de195cf33f">XPlmi_ProcessMailbox()</a>, and <a class="el" href="xplmi__defs_8h.html#a592ed4f8a2aba9571489d28755f7ba1a">XPLMI_TAMPER_TRIGGER_CMD_ID</a>.</p>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
	<p class="footer">&copy; Copyright 2015-2022 Xilinx, Inc. All Rights Reserved.</p>
	<p class="footer">&copy; Copyright 2022-2023 Advanced Micro Devices, Inc. All Rights Reserved.</p>
</div>
</body>
</html>
